Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/docs benchmarks example #33

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

StatisMike
Copy link

All changes were applied while benchmarking, to make sure there were no regressions made during changes.

Additions:

  • examples for wfc adds two examples for WFC algorithm. In addition, the AsRef<WaveCell> impl for WaveCellRef, to allow applying the step-by-step collapse example in more readible way.
  • benchmarks - addition of benchmarks, both for wfc-image and wfc (base)
  • additional documentation - addition of some documentation for the most important members, as well as a brief overview in wfc/lib.rs with pointers on how to implement the algorithm in external crates. There are still possibilities for better docs, but these pointers alone make the implementation easier, so at least partially fixes Better documentation of public members #32
  • clippy suggestions - clippy pointed to some things, I've fixed that.

It should be possible to apply every commit independently, so feel free to cherry-pick.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Better documentation of public members
1 participant